/*
     Copyright (C) 2011 Benny Mackney

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

#ifndef FPSREGULATOR_H
#define FPSREGULATOR_H

#include "bennysc.h"
#include <SDL/SDL.h>

class FpsRegulator
{
    public:
        //! Constructor
        FpsRegulator();
        //! Constructor with defined FPS goal
        FpsRegulator(int FPS);
        //! Destructor
        virtual ~FpsRegulator();
        //! If it's been less than 1 frame since the last time this was called, wait until that 1 frame is up
        void tick_wait();
        //! Define the maximum framerate (in FPS)
        void set_fpsGoal(int FPS);
        //! Get the framerate (as of the last frame)
        float get_fps();
        //! Get the smoothed framerate (average of last two frames)
        float get_sfps();
    protected:
    private:
        int tickTimeStart;
        int tickTimeGoal;
        int fpsGoal;
        float smoothRate;
        float smoothedFps;
        float lastFps;

};

#endif // FPSREGULATOR_H
